PUT
/
v1
/
system
/
userRoles
/
{type}
/
{id}
Update one User Role
curl --request PUT \
  --url https://{client_id}.shipstream.app/api/global/v1/system/userRoles/{type}/{id} \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "OrganizationUserRole",
  "name": "Administrators",
  "permissions": [
    "warehouse",
    "warehouse/staff",
    "warehouse/staff/time_entry_log",
    "warehouse/staff/time_management",
    "warehouse/staff/time_management/excluded",
    "warehouse/staff/time_management/status_dashboard"
  ]
}'
This response does not have an example.

Path Parameters

​
type
enum<string>
required

Specify the user type to which your operations will be restricted.

Available options:
any,
organization,
client
​
id
integer
required

The id of the referenced UserRole.

Required range: x >= 1

Body

application/json

Updates an existing UserRole specified by its type and id path parameters and according to the request body.

An OrganizationUserRole is used to provide a specific set of permissions to an organization's user.

Response

200

OK - The operation completed successfully and there is no response body.